Skip to main content

WKS Platform Installation Guide

Option 1: Running with Pre-built Docker Images​

⚠️ Warning: The provided Docker Compose files are recommended only for development or test environments.

This guide outlines the steps to quickly set up and run the WKS Platform using pre-built Docker images. This approach provides a seamless and consistent environment with all necessary dependencies and services pre-configured.

🔧 Prerequisites​

  • Docker installed on your system
  • Git installed for cloning the repository

🏗️ WKS Infrastructure Kit

Rapidly provision your environment and evaluate WKS Platform using our standardized AWS CloudFormation templates.

Infrastructure-as-Code

Get production-ready templates for automated cloud setup.

→ Get the Kit

Technical Support

Assistance with cloud architecture and environment scaling.

→ Talk to an Expert

🚀 Step-by-Step Installation​

1. Clone the repository and create the env file​

git clone https://github.com/wkspower/wks-platform.git
cd wks-platform
cp .env-sample .env

2. Run Docker Compose (pulls pre-built images)​

docker compose up -d

The app images are pulled from the public GitHub Container Registry (ghcr.io/wkspower/*) — no build and no Maven/Yarn required. The default profiles (portal + demo) bring up the UI and run the one-shot loader that bootstraps the Keycloak realm/demo user and seeds sample cases, forms, and processes. Camunda 7 is the engine. Wait for the demo-data-loader container to reach Exited (0) before logging in.

Pin a specific release with WKS_VERSION in .env (defaults to the latest release). Camunda 8 is experimental and outdated — see experimental/camunda8/.

3. Configure Hostnames​

Add the following lines to your local hosts file to ensure proper routing of portal requests:

127.0.0.1 minio
::1       minio

🌐 Accessing the Web Applications​

Once all containers have started, you can access the following web applications:

WKS Platform Portal​

Camunda (7 or 8)​

Keycloak​

MinIO​

Note: It may take some time for the applications to become fully operational during the first run. If you encounter issues, wait a few moments and try again.

🛠️ Additional Details​

  • The MongoDB database used by the applications is accessible on port 27017.
  • Ensure all services are running by checking container statuses with:
docker ps

✅ Summary​

This guide enables developers and testers to deploy the WKS Platform using Docker with minimal setup. For production deployments, consult the advanced configuration and security guidelines provided in the full WKS documentation.

For support or questions, please refer to the WKS documentation site or contact your WKS system administrator.